vcMotionPath

vcMotionPath is a base class for One Way Path and Two Way Path behaviors.

See in: Overview

Module: vcBehaviors

Parent: vcContainer

Children: vcOneWayMotionPath, vcTwoWayMotionPath

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
AccelerationRealRWDefines rate of acceleration (mm/s^2) for components moving on path.

If zero, acceleration is not calculated.
AccumulateBooleanRWTurns on/off pile-up of components moving on path.
See more
If True, components on the path stop moving when they encounter a blocked component.
If False, components on the path stop moving when a component is blocked from exiting the path.
DecelerationRealRWDefines rate of deceleration (mm/s^2) for components moving on path.

If zero, deceleration is not calculated.
DetailCurveMotionBooleanRWTurns on/off detailed movement of components to and from path, for example when moving from linear path to curved path.
See more
If True, bound box of component is used to avoid intersecting with other components.
This might create a gap between components, for example components that are cylindrical. This also decreases simulation performance.

You can disable DetailCurveMotion if components are cylindrical or if a slight intersection between components when transferring from linear to curved path is not a concern.
FastSchedulingBooleanRWTurns on/off the optimization of moving components on the path.
See more
If True, the path limits the amount of generated events, thereby improving simulation performance.
If False, the path moves components at shorter increments, thereby increasing the amount of events and decreasing simulation performance.
InterpolationvcInterpolationTypeRWDefines mode used by path to interpolate its waypoints set in Path property.
PathList[vcFeatures.vcFrameFeature]RWDefines an ordered list of Frame features referenced as waypoints of path.
If set, path is calculated based on its interpolation mode.
PathAxisvcAxisAlignTypeRWDefines mode for calculating how much space a component occupies on path,
See more
thereby allowing the path to utilize its space and determine
if one or more components are blocked if SpaceUtilization property is set to True.

See vcAxisAlignType constants for more information.
PathLengthRealRGets the length of path. That is, the distance from first to last waypoint along the path.
RetainOffsetBooleanRWDefines if a component entering, placed or grabbed by the path is snapped to and aligned with path's axis.
See more
If True, a component retains its offset while moving on path.
If False, component is snapped to nearest point on path and its origin is aligned with calculated path.
SegmentSizeRealRWDefines the size of segments when path uses segmentation to move components to and from different sections of the path.
See more
If value is greater than zero, the number of path segments is calculated in order to determine the capacity of each segment based on total capacity of path. Therefore, components move on path based on the capacity of a proceeding segment.
SensorsList[vcFeatures.vcComponentPathSensor]RWList of sensors connected to path, which must be either component path or process point type sensors.
SpaceUtilizationBooleanRWDefines if components accumulating on path are kept separate from one another and how new components enter path.
See more
If False, components may overlap one another and/or pile up side by side, which might be useful if RetainOffset is set to True.
SpeedRealRWDefines the speed (mm/s) of path.

Events

Learn how to use events here. The events are also inherited from the parent class.

NameParametersDescription
OnMotionChangedvcComponent component,
vcMotionState state
Triggered when the state of a component's motion changes on a path.
If the state of a path is changed so that it affects the motion of all components on that path, this event is called for each of those components.
See more
Parameters:
component (vcComponent): The componet that motion path state has changed.
state (vcMotionState): The new component's motion path state.
OnPhysicalTransitionvcContainer container,
vcComponent component,
Boolean arrive_leave
Triggered when either a) the leading edge of a component enters path or b) the trailing edge of a component exits path.
See more
Parameters:
container (vcContainer): The container argument is the current container of the component given in the component argument,
which may not be the container of component at the time of the call since the component may have transitioned elsewhere.

component (vcComponent): The component

arrive_leave (Boolean): It is True if component is entering path; otherwise False means a component is exiting path.